<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Whm_Functions_Account</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Whm_Functions_Account</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-vars">Vars</a>
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">WHM API Account Functions</p>
<p class="description"><p>Calls to Account functions of the WHM XML and JSON APIs</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Peter Kumaschow  (pkumaschowATgmail.com)</li>
				<li><span class="field">copyright:</span> Peter Kumaschow 2011</li>
				<li><span class="field">link:</span> <a href="http://docs.cpanel.net/twiki/bin/view/SoftwareDevelopmentKit/XmlApi">http://docs.cpanel.net/twiki/bin/view/SoftwareDevelopmentKit/XmlApi</a></li>
				<li><span class="field">license:</span> GNU</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Functions---Account.php.html">/Functions/Account.php</a> (line <span class="field">35</span>)
		</p>
		
				
		<pre><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html">Whm_Functions_Abstract</a>
   |
   --Whm_Functions_Account</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-vars">Vars</a>
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																				
												<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#accountsummary" title="details" class="method-name">accountsummary</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#changepackage" title="details" class="method-name">changepackage</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$pkg</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#createacct" title="details" class="method-name">createacct</a>
											(<span class="var-type"><a href="../../whm-lib/Account/Whm_Account_Create.html">Whm_Account_Create</a></span>&nbsp;<span class="var-name">$account</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#domainuserdata" title="details" class="method-name">domainuserdata</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#editquota" title="details" class="method-name">editquota</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$quota</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#limitbw" title="details" class="method-name">limitbw</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$bwlimit</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#listaccts" title="details" class="method-name">listaccts</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#listsuspended" title="details" class="method-name">listsuspended</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#modifyacct" title="details" class="method-name">modifyacct</a>
											(<span class="var-type"><a href="../../whm-lib/Account/Whm_Account_Modify.html">Whm_Account_Modify</a></span>&nbsp;<span class="var-name">$account</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#myprivs" title="details" class="method-name">myprivs</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#passwd" title="details" class="method-name">passwd</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$pass</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#removeacct" title="details" class="method-name">removeacct</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$keepdns</span> = <span class="var-default">2</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#restoreaccount" title="details" class="method-name">restoreaccount</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$all</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$ip</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$mail</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$mysql</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$subs</span> = <span class="var-default">true</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#setsiteip" title="details" class="method-name">setsiteip</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#suspendacct" title="details" class="method-name">suspendacct</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$reason</span> = <span class="var-default">''</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#unsuspendacct" title="details" class="method-name">unsuspendacct</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html">Whm_Functions_Abstract</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_apiresponse">Whm_Functions_Abstract::$_apiresponse</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_method">Whm_Functions_Abstract::$_method</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_params">Whm_Functions_Abstract::$_params</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_querystring">Whm_Functions_Abstract::$_querystring</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_rest">Whm_Functions_Abstract::$_rest</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-vars">Vars</a>
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodaccountsummary" id="accountsummary"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">accountsummary</span> (line <span class="line-number">44</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieve pertinent information about a specific account</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			accountsummary
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$user</span>			</li>
				</ul>
		
			
	</div>
<a name="methodchangepackage" id="changepackage"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">changepackage</span> (line <span class="line-number">57</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">upgrade or downgrade a user's package</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			changepackage
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$pkg</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$user</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$pkg</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcreateacct" id="createacct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">createacct</span> (line <span class="line-number">70</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">create a new account using just the basic parameters</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			createacct
		</span>
					(<span class="var-type"><a href="../../whm-lib/Account/Whm_Account_Create.html">Whm_Account_Create</a></span>&nbsp;<span class="var-name">$account</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">whmAccount</span>
				<span class="var-name">$account</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddomainuserdata" id="domainuserdata"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">domainuserdata</span> (line <span class="line-number">86</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieve user data for a specific domain.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			domainuserdata
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$domain</span>			</li>
				</ul>
		
			
	</div>
<a name="methodeditquota" id="editquota"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">editquota</span> (line <span class="line-number">99</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Alter the disk quota for a user</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			editquota
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$quota</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$quota</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$user</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlimitbw" id="limitbw"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">limitbw</span> (line <span class="line-number">123</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Limit Bandwidth Usage (Transfer) — limitbw</p>
<p class="description"><p>This function modifies the bandwidth usage (transfer) limit  for a specific account.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			limitbw
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$bwlimit</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$bwlimit</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$user</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlistaccts" id="listaccts"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">listaccts</span> (line <span class="line-number">134</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">retrieves a list of all accounts</p>
	<ul class="tags">
				<li><span class="field">return:</span> of objects</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			listaccts
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodlistsuspended" id="listsuspended"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">listsuspended</span> (line <span class="line-number">147</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns a list of suspended accounts</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			listsuspended
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodmodifyacct" id="modifyacct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">modifyacct</span> (line <span class="line-number">158</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">modify a user account</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			modifyacct
		</span>
					(<span class="var-type"><a href="../../whm-lib/Account/Whm_Account_Modify.html">Whm_Account_Modify</a></span>&nbsp;<span class="var-name">$account</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">whmAccount</span>
				<span class="var-name">$account</span>			</li>
				</ul>
		
			
	</div>
<a name="methodmyprivs" id="myprivs"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">myprivs</span> (line <span class="line-number">178</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generate a list of features you are allowed to use in WHM.</p>
<p class="description"><p>Each feature will display either a 1 or 0.  You are only able to use features with a corresponding 1</p><p>privs-&gt;all (boolean) — Provides all access privileges to the user.  Warning: If this feature is set to 1, the user has root access.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			myprivs
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodpasswd" id="passwd"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">passwd</span> (line <span class="line-number">190</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">change a user's password</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			passwd
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$pass</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$user</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$pass</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremoveacct" id="removeacct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">removeacct</span> (line <span class="line-number">203</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Terminate an account</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			removeacct
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$keepdns</span> = <span class="var-default">2</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$keepdns</span><span class="var-description">: <ol><li>= yes, 2 = no (default)</li></ol></span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$user</span>			</li>
				</ul>
		
			
	</div>
<a name="methodrestoreaccount" id="restoreaccount"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">restoreaccount</span> (line <span class="line-number">230</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Restore a user’s account from a backup file. You may restore a monthly,  weekly or daily backup.</p>
<p class="description"><p>This function is only available in version 11.27/11.28+.</p><p>To use this function, you must specify at least one of the  following parameters: mail, subs, all, mysql.</p><p>TODO: restoreaccount</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			restoreaccount
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$all</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$ip</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$mail</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$mysql</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$subs</span> = <span class="var-default">true</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$type</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$all</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$ip</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$mail</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$mysql</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$subs</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetsiteip" id="setsiteip"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setsiteip</span> (line <span class="line-number">277</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Change a Site's (or User's) IP Address — setsiteip</p>
<p class="description"><p>change the IP address of a website, or a user account,  hosted on your server</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			setsiteip
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$user</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$ip</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsuspendacct" id="suspendacct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">suspendacct</span> (line <span class="line-number">290</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Suspend a useraccount</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			suspendacct
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$reason</span> = <span class="var-default">''</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$reason</span><span class="var-description">: - optional but recommended</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$user</span>			</li>
				</ul>
		
			
	</div>
<a name="methodunsuspendacct" id="unsuspendacct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">unsuspendacct</span> (line <span class="line-number">301</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Unsuspend a user account</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			unsuspendacct
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$user</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html">Whm_Functions_Abstract</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#method__construct">Whm_Functions_Abstract::__construct()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodapplist">Whm_Functions_Abstract::applist()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodcheckParams">Whm_Functions_Abstract::checkParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methoddecode">Whm_Functions_Abstract::decode()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetApi">Whm_Functions_Abstract::getApi()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetMethod">Whm_Functions_Abstract::getMethod()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetParams">Whm_Functions_Abstract::getParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetQueryString">Whm_Functions_Abstract::getQueryString()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodpost">Whm_Functions_Abstract::post()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodquickpost">Whm_Functions_Abstract::quickpost()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetApi">Whm_Functions_Abstract::setApi()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetMethod">Whm_Functions_Abstract::setMethod()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetParams">Whm_Functions_Abstract::setParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetQueryString">Whm_Functions_Abstract::setQueryString()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodvalidateParams">Whm_Functions_Abstract::validateParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodversion">Whm_Functions_Abstract::version()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 06 Nov 2011 23:33:12 +1100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>